Developer CD Series 1998 August: Tool Chest/Dev.CD Aug 98 TC.toast/Tool Chest/Testing & Debugging/Mac OS Development Toolkit/Automation Essentials 2.3.0/Host Automation Folder/VU External Tool libs/Ivy Tool Declaration.vulib

Text File | 1998-03-19 | 6.5 KB | 236 lines | [TEXT/MPS ]

(*
        File:        Ivy Services for Virtual User 2.1 version 1.2

        Contains:    The Ivy 1.2 Virtual User tool declaration..

        Written by:    Rich Millet

        Copyright:    © 1994-1997 by Apple Computer, Inc., all rights reserved.

 *)


#
#    Change history (most recent first):
#        Version      Date        Who        Comments
#        =======    ========    ===        =============
#        1.4.0    02/03/97    JAS        Added 'vers' resources to library.
#                                    These should always match tool version when tool is revved.
#
#
#

                                # NEVER make direct calls to the Ivy external tool.
tool Ivy signature:'IVYX'        # Do NOT make direct external tool calls!
begin                            # Use the ‘Tasks’ instead!

Service "IVINIT"                #--------------------------------------------------------------
(
)
return    'Symbol';                #


Service "IVSETTOOLCMD"            #--------------------------------------------------------------
(
        'String',                # The tool's Gestalt selector.
        'Integer',                # The number of the command that the tool will do.
        'Symbol',                # The context parameter.
        'Integer',                # The first parameter.
        'Integer',                # The second parameter.
        'Integer',                # The third parameter.
        'Integer'                # The fourth parameter.
)
return    'Integer';


Service "IVUNSETTOOLCMD"        #--------------------------------------------------------------
(
        'String'                # The tool's Gestalt selector.
)
return    'Integer';


Service "IVSENDTOOLCMD"            #--------------------------------------------------------------
(
        'String',                # The tool's Gestalt selector.
        'Integer',                # The number of the command that the tool will do.
        'Integer',                # The first parameter.
        'Integer',                # The second parameter.
        'Integer',                # The third parameter.
        'Integer'                # The fourth parameter.
)
return    'Integer';                # The result of the tool's command.


Service "IVSETDIRECTORY"        #--------------------------------------------------------------
(
        'String'                # The full or partial pathname to set the default directory to
)
return    'String';                # The full default pathname.


Service "IVGETDIRECTORY"        #--------------------------------------------------------------
(
)
return    'String';                # The full default pathname.


Service "IVDELETEIMAGE"            #--------------------------------------------------------------
(
        'String'                # The name of the file to delete.
)
return 'Symbol';

Service "IVCHECKSUMIMAGE"        #--------------------------------------------------------------
(
        'String',                # The file name.
        'List',                    # The rectangular area of the screen to checksum.
        'Symbol'                # A boolean indicating whether or not to create a file.
)
return 'Integer';                # The 32 bit integer checksum.


Service "IVCREATEIMAGE"            #--------------------------------------------------------------
(
        'String',                # The name to give the image file.
        'List',                    # The rectangular area of the screen to capture.
        'List'                    # A list of rectangular areas to mask from the image.
)
return 'Integer';                # The 32 bit integer checksum of the image.


Service "IVCOMPAREIMAGES"        #--------------------------------------------------------------
(
        'String',                # The name of the first image.
        'String',                # The name of the second image.
        'String',                # The name of the file that shows the differences.
        'List'                    # A list of rectangular area to ignore during the comparison.
)
return    'Symbol';                # is true if the images matched, otherwise is false.


Service    "IVGETIMAGEINFO"        #--------------------------------------------------------------
(
        'String'                # The name of the image file.
)
return    'List';                    # A list of image information.


Service "IVWAITFORIMAGE"        #--------------------------------------------------------------
(
        'String',                # The name of the image file.
        'List',                    # EXACT rectangular screen area where the image will appear.
        'Integer'                # The percentage of targets CPU to use looking for the image.
)
return    'List';                    # { startTime, timeFount, timeIvyUsed, frequency }


Service "IVSTARTWAITFORIMAGE"    #--------------------------------------------------------------
(
        'String',                # The name of the image file.
        'List',                    # EXACT rectangular screen area where the image will appear.
        'Integer'                # The percentage of targets CPU to use looking for the image.
)
return    'List';                    # { startTime, frequency }


Service "IVGETTIMEFOUND"        #--------------------------------------------------------------
(
        'Integer'                # The process ID
)
return    'Integer';                # The time when Ivy found the image; 0 if not found.


Service "IVSTOPWAITFORIMAGE"    #--------------------------------------------------------------
(
        'Integer'                # The process ID
)
return    'Integer';                # The total time Ivy used while looking for the image.


Service "IVGETCURRENTTIME"        #--------------------------------------------------------------
(
)
return    'Integer';                # The current time.


Service    "IVSUBTRACTTIMES"        #--------------------------------------------------------------
(
        'undefined',            # The minuend.
        'undefined'                # The subtrahend
)
return    'Integer';                # minuend - subtrahend


Service "IVLOCATEIMAGE"            #--------------------------------------------------------------
(
        'String',                # The name of the image file.
        'List',                    # The rectangular screen area to in which to search
        'List'                    # The rectangle where the image was last found.
)
return    'List';                    # The location of the image.


Service "IVLOCATESTRING"        #--------------------------------------------------------------
(
        'String',                # The string to look for.
        'List',                    # The rectangular screen area to in which to search
        'String',                # The font name.
        'Integer',                # The font size.
        'Integer',                # The font style.
        'List'                    # The last location of the image.
)
return    'List';                    # The location of the image.


Service "INITIALIZE"            #--------------------------------------------------------------
(
        'undefined'
);


Service "CANCEL"                #--------------------------------------------------------------
(
        'String'
);


Service "GETTOOLSERVICES"        #--------------------------------------------------------------
(
)
return    'List';


Service "GETTOOLVERSION"        #--------------------------------------------------------------
(
)
return    'List';


Service "IVGETTOOLVERSION"        #--------------------------------------------------------------
(
)
return    'Integer';


Service "POLL"                    #--------------------------------------------------------------
(
        'String'
)
return    'String';


Service "SERVICESUPPORTED"        #--------------------------------------------------------------
(
        'String'
)
return    'undefined';


Service "QUIT"();
                                                    # NEVER make direct calls to the Ivy external tool.
end;                                                # Do NOT make direct external tool calls!
                                                    # Use the ‘Tasks’ instead!